Skip to content

Conversation

@cpyle0819
Copy link
Contributor

@cpyle0819 cpyle0819 commented Jul 7, 2025

This PR completes the filesystem abstraction by updating doc_gen.py functions.

Changes Made

  • Updated collect_snippets method to pass fs parameter to imported functions
  • Ensures filesystem abstraction is used consistently throughout the DocGen class

Functions Updated

  • collect_snippets method now passes fs=self.fs to:
    • collect_snippets function from snippets module
    • collect_snippet_files function from snippets module

Notes

  • Other methods like process_metadata, find_and_process_metadata, and parse_config were already using filesystem abstraction correctly
  • No additional tests needed as existing tests already use filesystem abstraction and our changes are minimal
  • Code formatting verified with black

This completes the filesystem abstraction work across the core modules.

@cpyle0819 cpyle0819 force-pushed the iteration-3-snippets branch from ca0e870 to 81a104e Compare July 7, 2025 18:27
@cpyle0819 cpyle0819 force-pushed the iteration-4-doc-gen branch from 377ae6a to f0606d0 Compare July 7, 2025 18:29
@cpyle0819 cpyle0819 requested a review from DavidSouther July 7, 2025 18:42
@cpyle0819 cpyle0819 self-assigned this Jul 7, 2025
@cpyle0819 cpyle0819 force-pushed the iteration-3-snippets branch from 81a104e to bfc932a Compare July 7, 2025 20:37
@cpyle0819 cpyle0819 force-pushed the iteration-4-doc-gen branch from f0606d0 to a63d55e Compare July 7, 2025 20:41
@cpyle0819 cpyle0819 changed the base branch from iteration-3-snippets to main July 7, 2025 20:56
@cpyle0819 cpyle0819 force-pushed the iteration-4-doc-gen branch from a63d55e to 2a942ab Compare July 7, 2025 20:58
@cpyle0819 cpyle0819 added the Enhancement A general update to the code base. label Jul 7, 2025
- Update collect_snippets method to pass fs parameter to imported functions
- Ensures collect_snippets() and collect_snippet_files() use filesystem abstraction
@cpyle0819 cpyle0819 force-pushed the iteration-4-doc-gen branch from 2a942ab to e6cb57f Compare July 7, 2025 21:16
@cpyle0819 cpyle0819 changed the title Iteration 4: Abstract filesystem operations in doc_gen.py Abstract filesystem operations in doc_gen.py Jul 7, 2025
@DavidSouther DavidSouther merged commit 912b261 into main Jul 7, 2025
2 checks passed
@cpyle0819 cpyle0819 deleted the iteration-4-doc-gen branch July 8, 2025 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Enhancement A general update to the code base.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants